<!DOCTYPE html>
<html lang="en-US">
    <head>
        <title>File::Finder - nice wrapper for File::Find ala find(1) - metacpan.org</title>
        <link rel="preload" as="fetch" href="https://metacpan.org/account/login_status" crossorigin="anonymous" />
        <link href="https://metacpan.org/_assets/b8ccceeed47a0652049703d99326a9cea4933443.css" rel="stylesheet" type="text/css">
        <script src="https://metacpan.org/_assets/6bfedafe2d7caa915b7d84f61b45936818e3242e.js" type="text/javascript" defer></script>
        <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of File-Finder - MetaCPAN" href="https://metacpan.org/dist/File-Finder/releases.rss" />
        <link rel="canonical" href="./File::Finder.html" />
        <meta name="description" content="nice wrapper for File::Find ala find(1)" />
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5">
        <link rel="shortcut icon" href="https://metacpan.org/static/icons/favicon.ico">
        <link rel="apple-touch-icon" sizes="152x152" href="https://metacpan.org/static/icons/apple-touch-icon.png">
        <link rel="search" href="https://metacpan.org/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN">
        <script>
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

          (function(skey, ga_id){
            ga('create', ga_id, {
              siteSpeedSampleRate : 100,
              storage             : 'none',
              clientId            : localStorage.getItem(skey)
            });
            ga(function(tracker) {
              localStorage.setItem(skey, tracker.get('clientId'));
            });
            ga('send', 'pageview');
          })('ga:clientId', 'UA-27829474-1');
        </script>
<meta name="twitter:card"        content="summary" />
<meta name="twitter:url"         content="https://metacpan.org/pod/File::Finder" />
<meta name="twitter:title"       content="File::Finder" />
<meta name="twitter:description" content="nice wrapper for File::Find ala find(1)" />
<meta name="twitter:site"        content="metacpan" />
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="header-logo-large hidden-xs">
              <a href="https://metacpan.org/" tabindex="0">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#logo" />
                </svg>
              </a>
            </div>
            <div class="header-logo-icon visible-xs">
              <a href="https://metacpan.org/">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#dots" />
                </svg>
              </a>
            </div>
            <ul class="nav navbar-nav menu-items hidden-xs hidden-sm">
              <li><a href="https://metacpan.org/about">About</a></li>
              <li><a href="https://metacpan.org/about/sponsors">Sponsor</a></li>
              <li><a href="https://grep.metacpan.org/">grep::cpan</a></li>
              <li><a href="https://metacpan.org/recent">Recent</a></li>
              <li><a href="https://metacpan.org/about/faq">FAQ</a></li>
              <li><a href="https://metacpan.org/tools">Tools</a></li>
              <li><a href="https://fastapi.metacpan.org/">API</a></li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <button type="button" class="searchbar-btn visible-xs visible-sm">
                    <i class="fa fa-search button-fa-icon"></i>
                </button>
                <form action="https://metacpan.org/search" class="searchbar-form visible-md visible-lg search-form form-horizontal">
                   <input type="hidden" name="size" id="metacpan_search-size" value="20">
                  <div class="form-group">
                      <div class="search-group">
                        <i class="fa fa-search"></i>
                        <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value="">
                      </div>
                  </div>
                </form>
                    <li class="icon-slidepanel visible-xs visible-sm">
                      <button data-toggle="slidepanel" data-target=".slidepanel">
                        <span class="button-fa-icon">
                          <i class="fa fa-bars slidepanel-open"></i>
                          <i class="fa fa-times slidepanel-close"></i>
                        </span>
                      </button>
                    </li>
                <form action="https://metacpan.org/account/logout" method="POST" id="metacpan-logout"></form>
                <li class="dropdown logged_in" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li><a href="https://metacpan.org/account/identities">Identities</a></li>
                        <li><a href="https://metacpan.org/account/profile">Profile</a></li>
                        <li><a href="https://metacpan.org/account/favorite/list">Favorites</a></li>
                        <li>
                            <a href="./File::Finder.html#" type="button" onclick="$('#metacpan-logout').submit(); return false">
                              Logout
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_out" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li>
                            <a href="https://metacpan.org/login/github">
                                <i class="fab fa-github fa-fw"></i>
                                GitHub
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/twitter">
                                <i class="fab fa-twitter fa-fw"></i>
                                Twitter
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/google">
                                <i class="fab fa-google fa-fw"></i>
                                Google
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_placeholder">
                    <button>
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                    </button>
                </li>
            </ul>
        </nav>
        <div class="page-content ">
          <!--
          <div class="top-notify-banner">
            <i class="fas fa-info-circle"></i>
          </div>
          -->
          <nav class="sidebar">
            <div class="slidepanel">
              <ul class="nav-list ">
    <li class="nav-header no-margin-top">
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of File-Finder was released.">
      <span class="relatize">08 Apr 2005 19:50:53 UTC</span>
    </li>
  <li>
    Distribution: <a href="https://metacpan.org/dist/File-Finder">File-Finder</a>
  </li>
  <li>
    Module version: 0.53
  </li>
  <li>
    <a data-keyboard-shortcut="g s" href="https://metacpan.org/dist/File-Finder/source/lib/File/Finder.pm">Source</a>
    (<a href="https://metacpan.org/dist/File-Finder/source/lib/File/Finder.pm?raw=1">raw</a>)
  </li>
  <li>
    <a data-keyboard-shortcut="g b" href="https://metacpan.org/dist/File-Finder/source/lib/File">Browse</a>
    (<a href="https://metacpan.org/dist/File-Finder/source/lib/File?raw=1">raw</a>)
  </li>
    <li>
      <a data-keyboard-shortcut="g c" href="https://metacpan.org/dist/File-Finder/changes">Changes</a>
    </li>
    <li>
      <a class="nopopup" href="https://metacpan.org/dist/File-Finder/contribute">How to Contribute</a>
    </li>
    <li>
      <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://rt.cpan.org/Public/Dist/Display.html?Name=File-Finder">Issues</a>
      (6)
    </li>
    <li>
      <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=File-Finder+0.53" title="Matrix">Testers</a>
        <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/F/File-Finder.html?oncpan=1&amp;distmat=1&amp;version=0.53&amp;grade=2" style="color: #090">18</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/F/File-Finder.html?oncpan=1&amp;distmat=1&amp;version=0.53&amp;grade=3" style="color: #900">0</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/F/File-Finder.html?oncpan=1&amp;distmat=1&amp;version=0.53&amp;grade=4">0</a>)</span>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/MERLYN/File-Finder-0.53">Kwalitee</a>
    </li>
    <li>
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on File-Finder who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)">
      Bus factor: 0
      </div>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpancover.com/latest/File-Finder-0.53/index.html">65.82% Coverage </a>
    </li>
    <li>
      License: unknown
    </li>
    <li class="nav-header">Activity</li>
    <li>
<div class="activity-graph">
    <img src="https://metacpan.org/dist/File-Finder/activity.svg?res=month" />
    <div class="comment">24 month</div>
</div>
    </li>
    <li class="nav-header">Tools</li>
    <li>
      <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/M/ME/MERLYN/File-Finder-0.53.tar.gz">
      Download (<span itemprop="fileSize">14.15KB</span>)</a>
    </li>
    <li>
      <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FMERLYN%2FFile-Finder-0.53%2Flib%2FFile%2FFinder.pm">
        MetaCPAN Explorer
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/File-Finder/permissions">
        Permissions
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/File-Finder/releases.rss">
        Subscribe to distribution
      </a>
    </li>
    <li>
      <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog">
        Install Instructions
      </button>
    </li>
    <li>
      <form action="https://metacpan.org/search">
        <input type="hidden" name="q" value="dist:File-Finder">
        <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
      </form>
    </li>
    <li>
      <form action="https://grep.metacpan.org/search">
        <input type="hidden" name="qd" value="File-Finder">
        <input type="hidden" name="source" value="metacpan">
        <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
     </form>
    </li>
    <li class="version-jump">
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/File/Finder.pm&#39;" class="form-control tool-bar-form">
  <option disabled selected>Jump to version</option>
<option
  disabled
  value="MERLYN/File-Finder-0.53"
>0.53
  (MERLYN on 2005-04-08)</option>
<optgroup label="BackPAN">'
<option
  
  value="MERLYN/File-Finder-0.52"
>0.52
  (MERLYN on 2005-03-26)</option>
<option
  
  value="MERLYN/File-Finder-0.51"
>0.51
  (MERLYN on 2004-10-07)</option>
<option
  
  value="MERLYN/File-Finder-0.50"
>0.50
  (MERLYN on 2004-10-06)</option>
<option
  
  value="MERLYN/File-Finder-0.03"
>0.03
  (MERLYN on 2003-12-20)</option>
<option
  
  value="MERLYN/File-Finder-0.02"
>0.02
  (MERLYN on 2003-12-18)</option>
<option
  
  value="MERLYN/File-Finder-0.01"
>0.01
  (MERLYN on 2003-12-17)</option>
</optgroup>
</select>
    </li>
    <li class="version-diff">
<select onchange="document.location.href='/release/MERLYN/File-Finder-0.53/diff/' + encodeURIComponent(this.value) + '/lib/File/Finder.pm'
" class="form-control tool-bar-form">
  <option disabled selected>Diff with version</option>
<option
  disabled
  value="MERLYN/File-Finder-0.53"
>0.53
  (MERLYN on 2005-04-08)</option>
<optgroup label="BackPAN">'
<option
  
  value="MERLYN/File-Finder-0.52"
>0.52
  (MERLYN on 2005-03-26)</option>
<option
  
  value="MERLYN/File-Finder-0.51"
>0.51
  (MERLYN on 2004-10-07)</option>
<option
  
  value="MERLYN/File-Finder-0.50"
>0.50
  (MERLYN on 2004-10-06)</option>
<option
  
  value="MERLYN/File-Finder-0.03"
>0.03
  (MERLYN on 2003-12-20)</option>
<option
  
  value="MERLYN/File-Finder-0.02"
>0.02
  (MERLYN on 2003-12-18)</option>
<option
  
  value="MERLYN/File-Finder-0.01"
>0.01
  (MERLYN on 2003-12-17)</option>
</optgroup>
</select>
    </li>

    <li>
<ul class="dependencies">
  <li class="nav-header">Dependencies</li>
  <li><a href="https://metacpan.org/pod/Test::More" title="Test::More" class="ellipsis">Test::More</a></li>
  <li><a href="https://metacpan.org/pod/Text::Glob" title="Text::Glob" class="ellipsis">Text::Glob</a></li>
  <li><i class="ttip" title="dynamic_config enabled">and possibly others</i></li>
  <li>
    <hr>
  </li>
  <li>
    <a href="https://metacpan.org/module/File::Finder/requires">Reverse dependencies</a>
  </li>
  <li>
    <a href="http://deps.cpantesters.org/?module=File%3A%3AFinder">CPAN Testers List</a>
  </li>
  <li>
    <a href="https://cpandeps.grinnz.com/?dist=File-Finder">Dependency graph</a>
  </li>
</ul>
    </li>
    <li class="nav-header">Permalinks</li>
    <li>
      <a href="https://metacpan.org/release/MERLYN/File-Finder-0.53/view/lib/File/Finder.pm">This version</a>
    </li>
    <li>
      <a href="./File::Finder.html">Latest version</a>
    </li>
    <li>
<div class="plussers">
<div class="nav-header">++ed by:</div>
<div>
<a class="display-all" href="https://metacpan.org/author/JEVIN"><img src="https://www.gravatar.com/avatar/54ec8b52daeeb3cc7532dddfe0e87a7b?d=identicon&amp;s=20" title="JEVIN" alt="JEVIN"></a>
</div>
<!-- Display counts of plussers-->
<div>
    <a href="https://metacpan.org/dist/File-Finder/plussers">1 PAUSE user</a>
</div>
</div>
    </li>
    <li>
    </li>
              </ul>
            </div>
          </nav>
          <div class="content-navigation">
<div class="breadcrumbs">
  <span>
    <a data-keyboard-shortcut="g a" rel="author" href="https://metacpan.org/author/MERLYN" class="author-name">Randal L. Schwartz</a>
  </span>
  <span>&nbsp;/&nbsp;</span>
  <div class="release dist-release status-latest maturity-released">
    <span class="dropdown"><b class="caret"></b></span>
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/File/Finder.pm&#39;" class="">
<option
  selected
  value="MERLYN/File-Finder-0.53"
>0.53
  (MERLYN on 2005-04-08)</option>
<optgroup label="BackPAN">'
<option
  
  value="MERLYN/File-Finder-0.52"
>0.52
  (MERLYN on 2005-03-26)</option>
<option
  
  value="MERLYN/File-Finder-0.51"
>0.51
  (MERLYN on 2004-10-07)</option>
<option
  
  value="MERLYN/File-Finder-0.50"
>0.50
  (MERLYN on 2004-10-06)</option>
<option
  
  value="MERLYN/File-Finder-0.03"
>0.03
  (MERLYN on 2003-12-20)</option>
<option
  
  value="MERLYN/File-Finder-0.02"
>0.02
  (MERLYN on 2003-12-18)</option>
<option
  
  value="MERLYN/File-Finder-0.01"
>0.01
  (MERLYN on 2003-12-17)</option>
</optgroup>
</select>
    <a data-keyboard-shortcut="g d" class="release-name" href="https://metacpan.org/dist/File-Finder">File-Finder-0.53</a>
  </div>
<span class="river-gauge-gauge">
  <svg width="24px"
       height="15px"
       version="1.1"
       xmlns="http://www.w3.org/2000/svg"
       xmlns:xlink="http://www.w3.org/1999/xlink">

    <g>
      <title>        River stage zero &#10;
          No dependents
      </title>

      <rect x="0"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="5"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="10"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="15"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="20"  y="0" width="4" height="15" fill="#e4e2e2" />
    </g>
  </svg>

</span>
<div id="File-Finder-fav" class="logged_in">
<form action="https://metacpan.org/account/favorite/add" style="display: inline" onsubmit="return favDistribution(this)">
    <input type="hidden" name="remove" value="0">
    <input type="hidden" name="release" value="File-Finder-0.53">
    <input type="hidden" name="author" value="MERLYN">
    <input type="hidden" name="distribution" value="File-Finder">
    <button type="submit" class="favorite highlight"><span>1</span> ++</button>
</form>
</div>
<div class="logged_out">
<a href="./File::Finder.html" onclick="alert('Please sign in to add favorites'); return false" class="favorite highlight">
<span>1</span> ++</a>
</div>
   / <span>File::Finder</span>
</div>
          </div>
          <main class="content">


<nav class="toc">
  <div class="toc-header"><strong>Contents</strong></div>
<ul>
  <li><a href="./File::Finder.html#NAME">NAME</a></li>
  <li><a href="./File::Finder.html#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="./File::Finder.html#DESCRIPTION">DESCRIPTION</a>
    <ul>
      <li><a href="./File::Finder.html#META-METHODS">META METHODS</a></li>
      <li><a href="./File::Finder.html#STEPS">STEPS</a></li>
      <li><a href="./File::Finder.html#SPEED">SPEED</a></li>
    </ul>
  </li>
  <li><a href="./File::Finder.html#SEE-ALSO">SEE ALSO</a></li>
  <li><a href="./File::Finder.html#BUGS">BUGS</a></li>
  <li><a href="./File::Finder.html#AUTHOR">AUTHOR</a></li>
  <li><a href="./File::Finder.html#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a></li>
</ul></nav>
<div class="pod anchors">
<h1 id="NAME">NAME</h1>

<p>File::Finder - nice wrapper for File::Find ala find(1)</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code>  use File::Finder;
  ## simulate &quot;-type f&quot;
  my $all_files = File::Finder-&gt;type(&#39;f&#39;);

  ## any rule can be extended:
  my $all_files_printer = $all_files-&gt;print;

  ## traditional use: generating &quot;wanted&quot; subroutines:
  use File::Find;
  find($all_files_printer, @starting_points);  

  ## or, we can gather up the results immediately:
  my @results = $all_files-&gt;in(@starting_points);

  ## -depth and -follow are noted, but need a bit of help for find:
  my $deep_dirs = File::Finder-&gt;depth-&gt;type(&#39;d&#39;)-&gt;ls-&gt;exec(&#39;rmdir&#39;,&#39;{}&#39;);
  find($deep_dirs-&gt;as_options, @places);</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p><code>File::Find</code> is great, but constructing the <code>wanted</code> routine can sometimes be a pain. This module provides a <code>wanted</code>-writer, using syntax that is directly mappable to the <i>find</i> command&#39;s syntax.</p>

<p>Also, I find myself (heh) frequently just wanting the list of names that match. With <code>File::Find</code>, I have to write a little accumulator, and then access that from a closure. But with <code>File::Finder</code>, I can turn the problem inside out.</p>

<p>A <code>File::Finder</code> object contains a hash of <code>File::Find</code> options, and a series of steps that mimic <i>find</i>&#39;s predicates. Initially, a <code>File::Finder</code> object has no steps. Each step method clones the previous object&#39;s options and steps, and then adds the new step, returning the new object. In this manner, an object can be grown, step by step, by chaining method calls. Furthermore, a partial sequence can be created and held, and used as the head of many different sequences.</p>

<p>For example, a step sequence that finds only files looks like:</p>

<pre><code>  my $files = File::Finder-&gt;type(&#39;f&#39;);</code></pre>

<p>Here, <code>type</code> is acting as a class method and thus a constructor. An instance of <code>File::Finder</code> is returned, containing the one step to verify that only files are selected. We could use this immediately as a <code>File::Find::find</code> wanted routine, although it&#39;d be uninteresting:</p>

<pre><code>  use File::Find;
  find($files, &quot;/tmp&quot;);</code></pre>

<p>Calling a step method on an existing object adds the step, returning the new object:</p>

<pre><code>  my $files_print = $files-&gt;print;</code></pre>

<p>And now if we use this with <code>find</code>, we get a nice display:</p>

<pre><code>  find($files_print, &quot;/tmp&quot;);</code></pre>

<p>Of course, we didn&#39;t really need that second object: we could have generated it on the fly:</p>

<pre><code>  find($files-&gt;print, &quot;/tmp&quot;);</code></pre>

<p><code>File::Find</code> supports options to modify behavior, such as depth-first searching. The <code>depth</code> step flags this in the options as well:</p>

<pre><code>  my $files_depth_print = $files-&gt;depth-&gt;print;</code></pre>

<p>However, the <code>File::Finder</code> object needs to be told explictly to generate an options hash for <code>File::Find::find</code> to pass this information along:</p>

<pre><code>  find($files_depth_print-&gt;as_options, &quot;/tmp&quot;);</code></pre>

<p>A <code>File::Finder</code> object, like the <i>find</i> command, supports AND, OR, NOT, and parenthesized sub-expressions. AND binds tighter than OR, and is also implied everywhere that it makes sense. Like <i>find</i>, the predicates are computed in a &quot;short-circuit&quot; fashion, so that a false to the left of the (implied) AND keeps the right side from being evaluated, including entire parenthesized subexpressions. Similarly, if the left side of an OR is false, the right side is evaluated, and if the left side of the OR is true, the right side is skipped. Nested parens are handled properly. Parens are indicated with the rather ugly <code>left</code> and <code>right</code> methods:</p>

<pre><code>  my $big_or_old_files = $files-&gt;left-&gt;size(&quot;+50&quot;)-&gt;or-&gt;atime(&quot;+30&quot;)-&gt;right;</code></pre>

<p>The parens here correspond directly to the parens in:</p>

<pre><code>  find somewhere -type f &#39;(&#39; -size +50 -o -atime +30 &#39;)&#39;</code></pre>

<p>and are needed so that the OR and the implied ANDs have the right nesting.</p>

<p>Besides passing the constructed <code>File::Finder</code> object to <code>File::Finder::find</code> directly as a <code>wanted</code> routine or an options hash, you can also call <code>find</code> implictly, with <code>in</code>. <code>in</code> provides a list of starting points, and returns all filenames that match the criteria.</p>

<p>For example, a list of all names in /tmp can be generated simply with:</p>

<pre><code> my @names = File::Finder-&gt;in(&quot;/tmp&quot;);</code></pre>

<p>For more flexibility, use <code>collect</code> to execute an arbitrary block in a list context, concatenating all the results (similar to <code>map</code>):</p>

<pre><code>  my %sizes = File::Finder
    -&gt;collect(sub { $File::Find::name =&gt; -s _ }, &quot;/tmp&quot;);</code></pre>

<p>That&#39;s all I can think of for now. The rest is in the detailed reference below.</p>

<h2 id="META-METHODS"><a id="META"></a>META METHODS</h2>

<p>All of these methods can be used as class or instance methods, except <code>new</code>, which is usually not needed and is class only.</p>

<dl>

<dt id="new">new</dt>
<dd>

<p>Not strictly needed, because any instance method called on a class will create a new object anyway.</p>

</dd>
<dt id="as_wanted">as_wanted</dt>
<dd>

<p>Returns a subroutine suitable for passing to <code>File::Find::find</code> or <code>File::Find::finddepth</code> as the <i>wanted</i> routine. If the object is used in a place that wants a coderef, this happens automatically through overloading.</p>

</dd>
<dt id="as_options">as_options</dt>
<dd>

<p>Returns a hashref suitable for passing to <code>File::Find::find</code> or <code>File::Find::finddepth</code> as the <i>options</i> hash. This is necessary if you want the meta-information to carry forward properly.</p>

</dd>
<dt id="in(@starting_points)"><a id="in"></a><a id="in-starting_points"></a>in(@starting_points)</dt>
<dd>

<p>Calls <code>File::Find::find($self-&gt;as_options, @starting_points)</code>, gathering the results, and returns the results as a list. At the moment, it also returns the count of those items in a scalar context. If that&#39;s useful, I&#39;ll maintain that.</p>

</dd>
<dt id="collect($coderef,-@starting_points)"><a id="collect"></a><a id="collect-coderef---starting_points"></a>collect($coderef, @starting_points)</dt>
<dd>

<p>Calls <code>$coderef</code> in a list context for each of the matching items, gathering and concatenating the results, and returning the results as a list.</p>

<pre><code>  my $f = File::Finder-&gt;type(&#39;f&#39;);
  my %sizes = $f-&gt;collect(sub { $File::Find::name, -s _ }, &quot;/tmp&quot;);</code></pre>

<p>In fact, <code>in</code> is implemented by calling <code>collect</code> with a coderef of just <code>sub { $File::Find::name }</code>.</p>

</dd>
</dl>

<h2 id="STEPS">STEPS</h2>

<p>See <a href="https://metacpan.org/pod/File::Finder::Steps">File::Finder::Steps</a>.</p>

<h2 id="SPEED">SPEED</h2>

<p>All the steps can have a compile-time and run-time component. As much work is done during compile-time as possible. Runtime consists of a simple linear pass executing a series of closures representing the individual steps (not method calls). It is hoped that this will produce a speed that is within a factor of 2 or 3 of a handcrafted monolithic <code>wanted</code> routine.</p>

<h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1>

<p><a href="https://metacpan.org/pod/File::Finder::Steps">File::Finder::Steps</a>, <a href="https://metacpan.org/pod/File::Find">File::Find</a>, <a href="find2perl.html">find2perl</a>, <a href="./File::Find::Rule.html">File::Find::Rule</a></p>

<h1 id="BUGS">BUGS</h1>

<p>Please report bugs to <code>bug-File-Finder@rt.cpan.org</code>.</p>

<h1 id="AUTHOR">AUTHOR</h1>

<p>Randal L. Schwartz, &lt;merlyn@stonehenge.com&gt;, with a tip of the hat to Richard Clamp for <code>File::Find::Rule</code>.</p>

<h1 id="COPYRIGHT-AND-LICENSE"><a id="COPYRIGHT"></a>COPYRIGHT AND LICENSE</h1>

<p>Copyright (C) 2003,2004 by Randal L. Schwartz, Stonehenge Consulting Services, Inc.</p>

<p>This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.2 or, at your option, any later version of Perl 5 you may have available.</p></div>

<div id="metacpan_install-instructions-dialog" class="modal fade">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title">Module Install Instructions</h4>
      </div>
      <div class="modal-body">
        <p>To install File::Finder, copy and paste the appropriate command in to your terminal.</p>
        <p><a href="https://metacpan.org/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p>
        <pre><code>cpanm File::Finder</code></pre>
        <p><a href="https://metacpan.org/pod/CPAN">CPAN shell</a></p>
        <pre><code>perl -MCPAN -e shell
install File::Finder</code></pre>
        <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p>
      </div>
      <div class="modal-footer">
        <a href="./File::Finder.html#" data-dismiss="modal" class="btn">Close</a>
      </div>
    </div>
  </div>
</div>
          </main>
          <div class="content-pagination">
          </div>
        </div>
        <footer class="footer">
          <div class="footer-container">
            <div class="footer-social">
              <div class="footer-link footer-logo">
                <a href="https://metacpan.org/">
                  <img src="https://metacpan.org/static/images/metacpan-logo.svg" alt="MetaCPAN" />
                </a>
              </div>
              <a class="footer-social-link" href="https://github.com/metacpan">
                <i class="fab fa-github-square"></i>
              </a>
              <a class="footer-social-link" href="https://fosstodon.org/@metacpan">
                <i class="fab fa-mastodon"></i>
              </a>
            </div>
            <div class="footer-links">
              <div class="footer-link">
                  <a href="https://metacpan.org/about">About</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/sponsors">Sponsor</a>
              </div>
              <div class="footer-link">
                  <a href="https://grep.metacpan.org">grep::cpan</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/recent">Recent</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/faq">FAQ</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/tools">Tools</a>
              </div>
              <div class="footer-link">
                  <a href="https://fastapi.metacpan.org/">API</a>
              </div>
              <div class="footer-link">
                  <a href="https://www.perl.org/">Perl.org</a>
              </div>
            </div>
            <div class="footer-sponsors">
              <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener">
                <img class="footer-sponsor-bytemark" src="https://metacpan.org/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener">
                <img class="footer-sponsor-liquidweb" src="https://metacpan.org/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener">
                <img class="footer-sponsor-deriv" src="https://metacpan.org/static/images/sponsors/deriv.svg" alt="Deriv logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener">
                <img class="footer-sponsor-geocode" src="https://metacpan.org/static/images/sponsors/geocodelogo.svg" alt="Geocode logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener">
                <img class="footer-sponsor-fastly" src="https://metacpan.org/static/images/sponsors/fastly_logo.svg" alt="Fastly logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener">
                <img class="footer-sponsor-opencage" src="https://metacpan.org/static/images/sponsors/open-cage.svg" alt="OpenCage logo">
              </a>
            </div>
          </div>
        </footer>
        <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts">
          <div class="modal-dialog">
            <div class="modal-content">
              <div class="modal-header">
                <button type="button" class="close" data-dismiss="modal">&times;</button>
                <h4 class="modal-title">Keyboard Shortcuts</h4>
              </div>
              <div class="modal-body row">
<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Global</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>s</kbd>
        </td>
        <td>Focus search bar</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>?</kbd>
        </td>
        <td>Bring up this help dialog</td>
      </tr>
    </tbody>
  </table>

  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>GitHub</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>p</kbd>
        </td>
        <td>Go to pull requests</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>go to github issues (only if github is preferred repository)</td>
      </tr>
    </tbody>
  </table>
</div>

<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>POD</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>a</kbd>
        </td>
        <td>Go to author</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>c</kbd>
        </td>
        <td>Go to changes</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>Go to issues</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>d</kbd>
        </td>
        <td>Go to dist</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>r</kbd>
        </td>
        <td>Go to repository/SCM</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>s</kbd>
        </td>
        <td>Go to source</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>b</kbd>
        </td>
        <td>Go to file browse</td>
      </tr>

    </tbody>
  </table>
</div>

<div class="col-md-12">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Search terms</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><em>module:</em> (e.g. <a href="https://metacpan.org/search?q=module%3APlugin">module:Plugin</a>)</td>
      </tr>
      <tr>
        <td><em>distribution:</em> (e.g. <a href="https://metacpan.org/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td>
      </tr>
      <tr>
        <td><em>author:</em> (e.g. <a href="https://metacpan.org/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td>
      </tr>
      <tr>
        <td><em>version:</em> (e.g. <a href="https://metacpan.org/search?q=version%3A1.00">version:1.00</a>)</td>
      </tr>
    </tbody>
  </table>
</div>
              </div>
              <div class="modal-footer"></div>
            </div>
          </div>
        </div>
    </body>
</html>
